home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 26.zip / BS1 part 26 / Cando v1.6 disk 2.adf / HelpFiles / Variables  < prev    next >
Text File  |  1992-01-31  |  9KB  |  489 lines
  1. F- Absolute                |absolute|
  2. F- Ascii                |ascii|
  3. F- CenterString            |centerstring|
  4. F- Char                    |char|
  5. C- Dispose                |dispose|
  6. C- DisposeAll            |disposeall|
  7. F- DupeString            |dupestring|
  8. V- False                |false|
  9. F- FindChars            |findchars|
  10. F- FindWord                |findword|
  11. F- Fraction                |fraction|
  12. F- GetChars                |getchars|
  13. F- GetWord                |getword|
  14. F- InsertChars            |insertchars|
  15. F- Integer                |integer|
  16. F- LeftJustify            |leftjustify|
  17. C- Let                    |let|
  18. F- Logical                |logical|
  19. F- LowerCase            |lowercase|
  20. F- Max                    |max|
  21. V- MaxInteger            |maxinteger|
  22. V- MaxValue                |maxvalue|
  23. F- Min                    |min|
  24. V- MinInteger            |mininteger|
  25. V- MinValue                |minvalue|
  26. V- No                    |no|
  27. V- Nothing                |nothing|
  28. F- NumberOfChars        |numberofchars|
  29. F- NumberOfWords        |numberofwords|
  30. V- Off                    |off|
  31. V- On                    |on|
  32. F- PositionOfWord        |positionofword|
  33. F- Random                |random|
  34. F- Real                    |real|
  35. F- RemoveChars            |removechars|
  36. F- RightJustify            |rightjustify|
  37. F- Round                |round|
  38. F- Sign                    |sign|
  39. F- SquareRoot            |squareroot|
  40. F- String                |string|
  41. F- TrimString            |trimstring|
  42. V- True                    |true|
  43. F- UpperCase            |uppercase|
  44. F- Whole                |whole|
  45. V- Yes                    |yes|
  46. [E]
  47.  
  48. |absolute|
  49. WT {Value}=Absolute({Value})
  50. PL Returns the absolute value of {Value}.
  51. ED
  52.  
  53. |ascii|
  54. WT {Integer}=Ascii({String})
  55. PL Returns the ASCII value of the first
  56. PL character in the string.
  57. PL
  58. PT SEE ALSO: 
  59. BS Char
  60. PT .
  61. ED
  62.  
  63. |centerstring|
  64. WT {String}=CenterString({String}, {Width} [,{WhiteSpace}])
  65. PL Returns a string containing a center
  66. PL justified string of a specified length.
  67. PL The string will be padded with the 
  68. PL {WhiteSpace} or, by default, spaces.
  69. PL
  70. PT SEE ALSO: 
  71. BS RightJustify
  72. PT  and 
  73. BS LeftJustify
  74. PT .
  75. ED
  76.  
  77. |char|
  78. WT {String}=Char({Integer})
  79. PL Returns a single character corresponding
  80. PL to an ASCII integer.
  81. PL
  82. PT SEE ALSO: 
  83. BS Ascii
  84. PT .
  85. ED
  86.  
  87. |dispose|
  88. WT Dispose <VarName>
  89. PL Erases the specified variable from
  90. PL memory.
  91. PL
  92. PT SEE ALSO: 
  93. BS DisposeAll
  94. PT .
  95. ED
  96.  
  97. |disposeall|
  98. WT DisposeAll
  99. PL Erases all variable from memory.
  100. PL
  101. PT SEE ALSO: 
  102. BS Dispose
  103. PT .
  104. ED
  105.  
  106. |dupestring|
  107. WT {String}=DupeString({String}, {Count})
  108. PL Duplicates the given string {Count} times
  109. PL and returns it as a single string.
  110. ED
  111.  
  112. |false|
  113. WT {Logical}=False
  114. PL The Logical or Boolean value FALSE.
  115. PL
  116. PT SEE ALSO: 
  117. BS No
  118. PT  and 
  119. BS Off
  120. PT .
  121. ED
  122.  
  123. |findchars|
  124. WT {Integer}=FindChars({SourceString}, {SearchString} [,{StartAtChar}])
  125. PL Returns the offset of the {SearchString}
  126. PL if found in the {SourceString}, or else
  127. PL it returns 0.  The search will begin at
  128. PL the {StartAtChar}.
  129. PL
  130. PT SEE ALSO: 
  131. BS FindWord
  132. PT .
  133. ED
  134.  
  135. |findword|
  136. WT {Integer}=FindWord({SourceString}, {SearchString} [,{StartAtWord} [,{WordDelimiters}]])
  137. PL Searches {SourceString} for the matching 
  138. PL {SearchString} and returns its word number.
  139. PL If not found it will return 0.  See Page
  140. PL 6-15 of the yellow manual for more details.
  141. PL
  142. PT SEE ALSO: 
  143. BS FindChars
  144. PT .
  145. ED
  146.  
  147. |fraction|
  148. WT {Value}=Fraction({Expression})
  149. PL Returns the fractional part of the 
  150. PL {Expression} when evaluated as a floating
  151. PL point value.
  152. PL
  153. PT SEE ALSO: 
  154. BS Whole
  155. PT .
  156. ED
  157.  
  158. |getchars|
  159. WT {String}=GetChars({String}, {StartAtChar}, {NumberOfChars})
  160. PL Returns a string of {NumberOfChars}
  161. PL characters taken from the {SourceString}
  162. PL beginning at the {StartAtChar}.
  163. PL
  164. PT SEE ALSO: 
  165. BS GetWord
  166. PT .
  167. ED
  168.  
  169. |getword|
  170. WT {String}=GetWord({String}, {WordNum} [,{WordDelimiters}])
  171. PL Returns the {WordNum} word in the
  172. PL {SourceString}.  See page 6-15 in the yellow
  173. PL manual about Word Delimiters.
  174. PL
  175. PT SEE ALSO: 
  176. BS GetChars
  177. PT .
  178. ED
  179.  
  180. |insertchars|
  181. WT {String}=InsertChars({SourceString}, {DestinationString} [,{StartAtChar}])
  182. PL Inserts a {SourceString} into the
  183. PL {DestinationString} at the specified offset.
  184. PL
  185. PT SEE ALSO: 
  186. BS RemoveChars
  187. PT .
  188. ED
  189.  
  190. |integer|
  191. WT {Integer}=Integer({Expression})
  192. PL Returns the result of the {Expression} as
  193. PL an Integer value.
  194. ED
  195.  
  196. |leftjustify|
  197. WT {String}=LeftJustify({String}, {Width} [,{WhiteSpace}])
  198. PL Returns a {String} containing a left
  199. PL justified string of a specified length.
  200. PL The string will be padded with the 
  201. PL {WhiteSpace} or, by default, spaces.
  202. PL
  203. PT SEE ALSO: 
  204. BS RightJustify
  205. PT  and 
  206. BS CenterString
  207. PT .
  208. ED
  209.  
  210. |let|
  211. WT Let <VarName>={Expression}
  212. PL This command assigns the results of the
  213. PL {Expression} to the variable <VarName>.
  214. ED
  215.  
  216. |logical|
  217. WT {Logical}=Logical({Expression})
  218. PL Returns the result of the {Expression} as
  219. PT an Logical or Boolean state.  
  220. BS False
  221. PL  would
  222. PT be any zero or null string and 
  223. BS True
  224. PL  would be
  225. PL any non-zero value.
  226. ED
  227.  
  228. |lowercase|
  229. WT {String}=LowerCase({String})
  230. PL Returns a {String} with all the characters
  231. PL converted to lowercase.
  232. PL
  233. PT SEE ALSO: 
  234. BS UpperCase
  235. PT .
  236. ED
  237.  
  238. |max|
  239. WT {Integer}=Max({Integer}, {Integer} [,up to ten integers])
  240. PL Returns the value of the largest argument.
  241. PL
  242. PT SEE ALSO: 
  243. BS Min
  244. PT .
  245. ED
  246.  
  247. |maxinteger|
  248. WT {Integer}=MaxInteger
  249. PL Returns the largest possible integer.
  250. PL
  251. PT SEE ALSO: 
  252. BS MinInteger
  253. PT  and 
  254. BS MaxValue
  255. PT .
  256. ED
  257.  
  258. |maxvalue|
  259. WT {Value}=MaxValue
  260. PL Returns the largest possible floating
  261. PL point value.
  262. PL
  263. PT SEE ALSO: 
  264. BS MaxInteger
  265. PT  and 
  266. BS MinValue
  267. PT .
  268. ED
  269.  
  270. |min|
  271. WT {Integer}=Min({Integer}, {Integer} [,up to ten integers])
  272. PL Returns the value of the smallest argument.
  273. PL
  274. PT SEE ALSO: 
  275. BS Max
  276. PT .
  277. ED
  278.  
  279. |mininteger|
  280. WT {Integer}=MinInteger
  281. PL Returns the smallest possible integer.
  282. PL
  283. PT SEE ALSO: 
  284. BS MaxInteger
  285. PT  and 
  286. BS MinValue
  287. PT .
  288. ED
  289.  
  290. |minvalue|
  291. WT {Value}=MinValue
  292. PL Returns the smallest possible floating point
  293. PL value.
  294. PL
  295. PT SEE ALSO: 
  296. BS MaxValue
  297. PT  and 
  298. BS MinInteger
  299. PT .
  300. ED
  301.  
  302. |no|
  303. WT {Logical}=No
  304. PL The Logical or Boolean value FALSE.
  305. PL
  306. PT SEE ALSO: 
  307. BS False
  308. PT  and 
  309. BS Off
  310. PT .
  311. ED
  312.  
  313. |nothing|
  314. WT {Nothing}=Nothing
  315. PL This returns the same as an uninitialized
  316. PL variable and is also the same as an null
  317. PL string variable.
  318. ED
  319.  
  320. |numberofchars|
  321. WT {Integer}=NumberOfChars({String})
  322. PL Returns the number of characters in the
  323. PL given {String}.
  324. PL
  325. PT SEE ALSO: 
  326. BS NumberOfWords
  327. PT .
  328. ED
  329.  
  330. |numberofwords|
  331. WT {Integer}=NumberOfWords({String} [,{WordDelimiters}])
  332. PL Returns the number of words in the given
  333. PL {String}.
  334. PL
  335. PT SEE ALSO: 
  336. BS NumberOfChars
  337. PT .
  338. ED
  339.  
  340. |off|
  341. WT {Logical}=Off
  342. PL The Logical or Boolean value FALSE.
  343. PL
  344. PT SEE ALSO: 
  345. BS No
  346. PT  and 
  347. BS False
  348. PT .
  349. ED
  350.  
  351. |on|
  352. WT {Logical}=On
  353. PL The Logical or Boolean value TRUE.
  354. PL
  355. PT SEE ALSO: 
  356. BS Yes
  357. PT  and 
  358. BS True
  359. PT .
  360. ED
  361.  
  362. |positionofword|
  363. WT {Integer}=PositionOfWord({String}, {WordNum} [,{WordDelimiters}])
  364. PL Returns the character position of the
  365. PL {WordNum} word in the {String}.  See page
  366. PL 6-16 in the yellow manual for more details.
  367. ED
  368.  
  369. |random|
  370. WT {Integer}=Random({MinimumInteger},{MaximumInteger})
  371. PL Returns a random integer between and
  372. PL including the {MinimumInteger} and
  373. PL {MaximumInteger} values.
  374. ED
  375.  
  376. |real|
  377. WT {Real}=Real({expression})
  378. PL Returns the result of the {Expression} as
  379. PL a floating point value.
  380. ED
  381.  
  382. |removechars|
  383. WT {String}=RemoveChars({String}, {StartAtChar}, {NumberOfChars})
  384. PL Removes characters from {SourceString}
  385. PL beginning at {StartAtChar} and for
  386. PL {NumberOfChars} amount of characters.
  387. PL
  388. PT SEE ALSO: 
  389. BS InsertChars
  390. PT .
  391. ED
  392.  
  393. |rightjustify|
  394. WT {String}=RightJustify({String}, {Width} [,{WhiteSpace}])
  395. PL Returns a {String} containing a right
  396. PL justified string of a specified length.
  397. PL The string will be padded with the 
  398. PL {WhiteSpace} or, by default, spaces.
  399. PL
  400. PT SEE ALSO: 
  401. BS LeftJustify
  402. PT  and 
  403. BS CenterString
  404. PT .
  405. ED
  406.  
  407. |round|
  408. WT {Value}=Round({Value} [,{DigitPlace})
  409. PL Rounds the given value to the specified
  410. PL digit place.  If {DigitPlace} is not given
  411. PL then we use 0.  See page 6-6 in the
  412. PL supplement manual for a full description
  413. PL of this command.
  414. ED
  415.  
  416. |sign|
  417. WT {Integer}=Sign({Value})
  418. PL Returns the sign of the value.
  419. PL
  420. PL    1 if value is positive.
  421. PL    0 if value is zero.
  422. PL   -1 if value is negative.
  423. ED
  424.  
  425. |squareroot|
  426. WT {Value}=SquareRoot({Value})
  427. PL Returns the square root of the given
  428. PL {Value}.
  429. ED
  430.  
  431. |string|
  432. WT {String}=String({Expression})
  433. PL Returns the result of the {Expression} as
  434. PL a text string.
  435. ED
  436.  
  437. |trimstring|
  438. WT {String}=TrimString({String})
  439. PL Returns a string with leading and trailing
  440. PL space and TAB characters removed.  Also,
  441. PL multiple space and TAB characters within
  442. PL the string are replaced with a single space.
  443. ED
  444.  
  445. |true|
  446. WT {Logical}=True
  447. PL The Logical or Boolean value TRUE.
  448. PL
  449. PT SEE ALSO: 
  450. BS Yes
  451. PT  and 
  452. BS On
  453. PT .
  454. ED
  455.  
  456. |uppercase|
  457. WT {String}=UpperCase({String})
  458. PL Returns a {String} with all the characters
  459. PL converted to uppercase.
  460. PL
  461. PT SEE ALSO: 
  462. BS LowerCase
  463. PT .
  464. ED
  465.  
  466. |whole|
  467. WT {Value}=Whole({Expression})
  468. PL Returns the whole number part of the 
  469. PL {Expression} when evaluated as a floating
  470. PL point value.
  471. PL
  472. PT SEE ALSO: 
  473. BS Fraction
  474. PT .
  475. ED
  476.  
  477. |yes|
  478. WT {Logical}=Yes
  479. PL The Logical or Boolean value TRUE.
  480. PL
  481. PT SEE ALSO: 
  482. BS True
  483. PT  and 
  484. BS On
  485. PT .
  486. ED
  487.  
  488.  
  489.